home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / catlog41.zip / CATLOG41.DOC < prev    next >
Text File  |  1992-02-20  |  14KB  |  429 lines
  1.    
  2.  
  3.           CatLog v4.10 - Activity Log Reporter/Bulletin Generator
  4.                                      By
  5.                           Greg Day & John Gormley
  6.                    SCC BBS! (313) 427-0223  Fido 1:120/193
  7.                            For WILDCAT! 3.x Systems
  8.                                February 20, 1992
  9.  
  10.  
  11.  
  12.  
  13.       This program has been run successfully on PC's of various types with
  14. the WILDCAT! BBS v. 3.02 datafiles.   We make no guaranties of any kind
  15. as to the worthiness of this program, only that it will use disk space.  We
  16. will not be held responsible for any damages incurred to you or your PC.
  17.       CatLog has been through several weeks of beta testing and all known
  18. bugs have been squashed.
  19.  
  20.                     **    Version 4.10 enhancements **
  21.  
  22.  - Minor bug fixes.
  23.  
  24.  - Optimized memory usage, can now process 18,000 files in one
  25.    pass with 500k free (for file listings).
  26.  
  27.  - CatLog now outputs a birthday bulletin.
  28.  
  29.  - CatLog will now automatically trim your activity log file(s) to a
  30.    specified number of days.  CatLog will optionally backup your logs.
  31.  
  32.  - The CatLog Install program now checks for valid paths upon exit.
  33.  
  34.  - Top 15 files can now be run without running the file list.
  35.  
  36.  - Now accepts command line parameters for file lists - bypassing cfg file.
  37.  
  38.  
  39.                     **    Version 4.00 enhancements  **
  40.  
  41.         We think you'll find this new version on CatLog much more
  42.  comprehensive than previous releases.  Below is a list of
  43.  CatLog 4.0 features:
  44.  
  45.  - Menu Driven Setup with Mouse support.
  46.  
  47.  - Support for up to 16 nodes.
  48.  
  49.  - Support for 192 file areas.
  50.  
  51.  - One Activity Log Summary Bulletin for all nodes.
  52.  
  53.  - Ability to use multiple configuration files.
  54.  
  55.  - Produces Downloadable file listing.
  56.  
  57.  - Generates Who Called Yesterday bulletin.
  58.  
  59.  - Generates Top 10 Callers bulletin.
  60.  
  61.  - Generates Top 10 Uploaders/Downloaders bulletin.
  62.  
  63.  - Generates Top 15 Files bulletin.
  64.  
  65.  - And of course an activity summary for each node if desired.
  66.  
  67.  - All files are open in read mode only for network support.
  68.  
  69.  - Totally re-written in Turbo Pascal v6.0. MUCH FASTER OPERATION!
  70.  
  71.  
  72.  
  73.                     **    Version 3.01 enhancements  **
  74.  
  75.  - Fixed bug when reading activity log.  If last entry in the Activity
  76.    log was an illegal logon attempt CatLog would not record days
  77.    activity. (Rare!)
  78.  
  79.  
  80.                      **    Version 3.0 enhancements   **
  81.  
  82.  - Compatible with Wildcat 3.0's activity log.  Outputs multiple
  83.    history files for multi-node systems.
  84.  
  85.  - The history file has changed names!  Previous to v 3.0 it was
  86.    called CATLOG.DAT.  It is now CATHST.XXX, where XXX corresponds
  87.    to the activity log number (eg. CATHST.001 for ACTIVITY.001).
  88.  
  89.  - Eliminated the -R and -N command line parameters.  The only parameter
  90.    supported now is the activity log number to process
  91.    (eg. CATLOG30 1 to process ACTIVITY.001).
  92.  
  93.  - Supports multiple configs. for multiple nodes. (.eg CATLOG.002 for
  94.    the node 2 activity log ACTIVITY.002).
  95.  
  96.  
  97.  
  98.                     **    Version 2.0 enhancements   **
  99.  
  100.  
  101.  - Now CatLog is user configurable!  Choose your own protocols, bps,
  102.    and anything else recorded in the WC activity log.
  103.  
  104.  - Uses BIOS writes for better operation under Desqview.
  105.  
  106.  - Configurable to work on Wildcat v 2.*
  107.  
  108.  
  109.  
  110.                      **    Version 1.1 enhancements   **
  111.  
  112.  - Places anything over 9600 bps in the 9600+ stats column.
  113.    In the future 19200 and 38000 connects will have their own
  114.    column.
  115.  
  116.  - We now print the daily average for each statistic.
  117.  
  118.  - Minor cleanup to the .bbs and .scr screens.
  119.  
  120.  - Better error handling.
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.                                Installation
  139.  
  140.  
  141.  
  142.                  Included in this zip file is:
  143.  
  144.                CATLOG41.EXE - The CatLog program.
  145.                CATLOGIN.EXE - The Installation/Config program.
  146.                CATLOGNT.CFG - Configuration file for CATLOG41.EXE.
  147.                CATLOG41.DOC - This file.
  148.                CATLOGNT.KEY - Your Key for CATLOG41.EXE.
  149.                CAT40-41.EXE - Conversion program for your old CATLOGNT.CFG
  150.                               file.
  151.  
  152.  
  153.  
  154.  
  155.  
  156.                If you are upgradeing from CatLog v4.0 be sure to
  157.                run the CAT40-41 program first to convert and expand
  158.                your v4.0 config file to the new v4.1 format. If you
  159.                wish to save your previous totals and setup do not
  160.                overwrite your current config file with the one supplied
  161.                in this archive.
  162.  
  163.                Registered users should not overwrite their registered
  164.                key with the one supplied in this archive!  If you do
  165.                just call our BBS and ask for a new one.
  166.  
  167.                Backup your old setup!
  168.  
  169.  
  170.        Unzip the contents of CATLOG41.ZIP into your Wildcat v3.X home
  171.        directory. A default configuration file is supplied. To
  172.        invoke the configuration program type CATLOGIN. The config
  173.        program will by default read in the CATLOGNT.CFG config file.
  174.  
  175.        If your files database contains more that 18,000 files it may
  176.        be necessary to run CatLog more than one time to produce
  177.        smaller downloadable file lists.  In this case you will need
  178.        more than one configuration file, including and excluding
  179.        file areas in each config file as needed.
  180.        If you use multiple configs you can later copy CATLOGNT.CFG
  181.        over to another name and make modifications to it by including
  182.        the config file name on the command line (ie: CATLOGIN CAT1.CFG).
  183.  
  184.  
  185.                                   Setup
  186.  
  187.  
  188.        Click your mouse or type ALT/S to open the setup menu. The
  189.        first item is Path Setup.  To access this item type A or
  190.        click your mouse on it. For keyboard users use the TAB key
  191.        to move between fields.  The RETURN key exits a window with
  192.        an "OK".
  193.  
  194.  
  195.  
  196.        Path Setup:
  197.  
  198.                1) 5 Character Bulletin Prefix. Used for
  199.                   generating Activity Log Summaries.
  200.                   Ex.  If your Prefix is CATLG, CatLog will
  201.                   output CATLG001.BBS for node one activity
  202.                   or CATLG000.BBS for a Multi-Node summary.
  203.  
  204.                   Note! The CATLG???.BBS files are placed in
  205.                   the same directory as your activity log file(s)!
  206.                   They should be renamed and copied to your
  207.                   bulletin directory if you wish to display them
  208.                   to your callers.
  209.  
  210.                2) Path\Name for File List.  If used this
  211.                   is the path and name of the downloadable
  212.                   file list.
  213.  
  214.                3) Path\Name for Top Ul/Dl Bulletin.  Enter
  215.                   the path and name for output of this
  216.                   bulletin.
  217.  
  218.                4) Path\Name for Top Callers Bulletin. Enter
  219.                   name and path for this bulletin.
  220.  
  221.                5) Path for Activity Logs.  This is usually the
  222.                   Wildcat home directory.
  223.  
  224.                6) Path\Name for Who Called Yesterday. Enter
  225.                   name and path for this bulletin.
  226.  
  227.                7) Path\Name for Top 15 File Bulletin. Enter
  228.                   name and path for this bulletin.
  229.  
  230.                8) Bar Charts is currently unused -  future release.
  231.  
  232.                9) Path\Name for Birthday bulletin.
  233.  
  234.               10) Path for MAKEWILD.DAT.  This is normally the
  235.                   Wildcat home directory.
  236.  
  237.  
  238.  
  239.  
  240.        Nodes:
  241.  
  242.                1) Click on or Toggle with the spacebar the
  243.                   Node(s) you'd like to include in your
  244.                   Activity log summary.  Selecting more nodes
  245.                   than you have is ok.  If you don't have an
  246.                   Activity.002 log, it will not effect the
  247.                   operation of CatLog.
  248.  
  249.  
  250.  
  251.        Search Data:
  252.  
  253.                1) Click on or Tab Down to Data To Search for.
  254.                   This is the information CatLog will key on
  255.                   to accumulate totals.  MOST OF THE DEFAULT
  256.                   DATA SUPPLIED IS SUFFICIENT, though you may
  257.                   add or modify it in any way.
  258.  
  259.                   For example, whenever CatLog finds the word
  260.                   "downloaded" in the activity log it will
  261.                   count that as one file download, likewise
  262.                   whenever the phase "DROPPED CARRIER" is
  263.                   encountered CatLog will add one to the
  264.                   dropped carrier count in the Catlog history
  265.                   file.
  266.  
  267.                   Note!  Text to search on is case sensative
  268.                   this text must be exactly what appears in the
  269.                   Wildcat Activity log file.
  270.  
  271.                2) Adjacent to the Data Search fields is the
  272.                   Text to print parameters.  This is the text
  273.                   you'll see in your bulletin(s). Example:
  274.  
  275.                   Phrase to Search           Out To Bulletin
  276.                   ===============            ===============
  277.                    downloaded                Files Downloaded
  278.                      ^                              ^
  279.                      |                              |
  280.  Text Found in Activity log file.           Text in Bulletin.
  281.  
  282.  
  283.  
  284.        Protocol Data:
  285.  
  286.                1) Same as above.  Enter the data (Protocols)
  287.                   to search for in the activity log  and then
  288.                   enter text to print in the displayed
  289.                   bulletin. Again, the defaults are usually
  290.                   sufficient.
  291.  
  292.  
  293.  
  294.        Baud Rate Data:
  295.  
  296.                1) Same as above.
  297.  
  298.                2) Also Enter your name and BBS name to output
  299.                   in fields supplied. This information will
  300.                   be displayed in your activity log summary
  301.                   bulletin.
  302.  
  303.  
  304.  
  305.        Flags:
  306.  
  307.                1) This is where you tell CatLog what to
  308.                   output.  Mark (Toggle or Click) on the
  309.                   options you'd like CatLog to process.
  310.  
  311.                   A special flag in this area is also included.
  312.                   If you run Desqview (or similar software), you
  313.                   may wish to turn off the USE DIRECT VIDEO
  314.                   flag.
  315.  
  316.                2) Enter the number of days you wish to keep in your
  317.                   activity log.  Enter 0 (zero) if you don't want CatLog
  318.                   to trim your activity log(s).
  319.  
  320.  
  321.        Exclude Name:
  322.  
  323.  
  324.                1) Enter Name(s) here that you would like
  325.                   excluded from the Top 10 Bulletins. These
  326.                   are usually Sysops & CO-Sysops.
  327.  
  328.  
  329.  
  330.        File Areas:
  331.  
  332.  
  333.                1) These are the File Areas you'd like included
  334.                   on your file list for download.  Toggle or
  335.                   click (mark with an X) on areas you like
  336.                   to include.  Marking more file areas than you
  337.                   have will not affect the operation of CatLog. 
  338.                   CatLog will only look at file areas set up in
  339.                   Makewild.
  340.  
  341.  
  342.  
  343.  
  344.  
  345.           To save your configuration file type ALT/F or click on the
  346.           FILE title bar.  Type S or click on the save option.
  347.  
  348.  
  349.  
  350.  
  351.                          Running CatLog
  352.  
  353.        CatLog should be run ONCE a day on or about 12:00 midnight
  354.        for best results.  The command line is as follows:
  355.  
  356.               CATLOG41 [CATLOGNT.CFG]
  357.  
  358.        If you have mulitiple configs you must invoke CATLOG41 once
  359.        for EACH configuration file, including the config file name
  360.        on the command line.  DO NOT run CATLOG41 more that once per
  361.        24hr period on the same configuration file.
  362.  
  363.  
  364.        If the configuration file is left off the command line CatLog
  365.        will use the default config file.
  366.  
  367.  
  368.        Optional command line parameters:
  369.   
  370.        If you wish to run a file list on just one file area and optionally
  371.        generate a top 15 files bulletin for the area you can do the following:
  372.  
  373.                          catlog41 /f=20 /t
  374.  
  375.        This statement will produce a file listing of area 20 and also produce
  376.        a Top 15 file bulletin for that area.  NOTE: When using the command
  377.        line parameter /F= your output file will have the extensions of
  378.        XXXXXX.020 (for file area 20) or XXXXXX.043 (for file area 43).
  379.        These output files will be placed in the directory specified for
  380.        your regular file list.
  381.        The /T parameter cannot be used alone, but must be used in conjunction
  382.        with the /F= parameter.  The /F= parameter on the other hand does not
  383.        require the use of the /T.  ONLY one file area allowed per run.
  384.  
  385.        
  386.                  Example batch file:
  387.  
  388.                       cd \wc30
  389.                       catlog41
  390.                       pkzip -a allfiles files.txt
  391.                       copy allfiles.zip d:\txt
  392.                       copy catlg000.bbs c:\wc30\bull\bull5.bbs
  393.                       del allfiles.zip
  394.                       del files.txt
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.                             Maintenance
  402.  
  403.  
  404.        You can also initialize totals kept for any node.  This is
  405.        handy if you add nodes at a later date and wish all nodes
  406.        to be in sync. or just to reset the totals for a particular
  407.        node. To access this feature in CATLOGIN.EXE :
  408.  
  409.                      1) Type ALT/F or Click your mouse
  410.                         on FILE.
  411.  
  412.                      2) Key down to or Click on Init. Nodes.
  413.  
  414.                      3) Enter the node number to initialize.
  415.  
  416.        Note!  If you add new nodes to your system and wish CatLog to
  417.               include it in your stats, you MUST first initialize it!
  418.                 
  419.  
  420.                       
  421.                 *****************************************
  422.                   This is a key based program. If you do
  423.                   not register CatLog within 60 days it
  424.                   will cease to run. Additional keys
  425.                   can be picked up from the authors BBS
  426.                   See REGISTER.DOC for more information.
  427.                 *****************************************
  428.  
  429.